<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>zdma: xzdma.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">zdma
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xzdma_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xzdma.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gad882e6d7430871e5b71643c8be2512d5"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__zdma.html#gad882e6d7430871e5b71643c8be2512d5">XZDma_CfgInitialize</a> (<a class="el" href="struct_x_z_dma.html">XZDma</a> *InstancePtr, <a class="el" href="struct_x_z_dma___config.html">XZDma_Config</a> *CfgPtr, u32 EffectiveAddr)</td></tr>
<tr class="memdesc:gad882e6d7430871e5b71643c8be2512d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function initializes an ZDMA core.  <a href="group__zdma.html#gad882e6d7430871e5b71643c8be2512d5">More...</a><br/></td></tr>
<tr class="separator:gad882e6d7430871e5b71643c8be2512d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf1772f190fe0a67a17c78f5f23fc8024"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__zdma.html#gaf1772f190fe0a67a17c78f5f23fc8024">XZDma_SetMode</a> (<a class="el" href="struct_x_z_dma.html">XZDma</a> *InstancePtr, u8 IsSgDma, <a class="el" href="xzdma_8h.html#a84e5ba98d56dac2078e4bc68d5b5ab92">XZDma_Mode</a> Mode)</td></tr>
<tr class="memdesc:gaf1772f190fe0a67a17c78f5f23fc8024"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets the pointer type and mode in which ZDMA needs to transfer the data.  <a href="group__zdma.html#gaf1772f190fe0a67a17c78f5f23fc8024">More...</a><br/></td></tr>
<tr class="separator:gaf1772f190fe0a67a17c78f5f23fc8024"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4f701b228ebc77f96faaba09cd9c63db"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__zdma.html#ga4f701b228ebc77f96faaba09cd9c63db">XZDma_CreateBDList</a> (<a class="el" href="struct_x_z_dma.html">XZDma</a> *InstancePtr, <a class="el" href="xzdma_8h.html#a8deecd1bc1f130b591748afb1790a013">XZDma_DscrType</a> TypeOfDscr, UINTPTR Dscr_MemPtr, u32 NoOfBytes)</td></tr>
<tr class="memdesc:ga4f701b228ebc77f96faaba09cd9c63db"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets the descriptor type and descriptor pointer's start address of both source and destination based on the memory allocated by user and also calculates no of descriptors(BDs) can be created in the allocated memory.  <a href="group__zdma.html#ga4f701b228ebc77f96faaba09cd9c63db">More...</a><br/></td></tr>
<tr class="separator:ga4f701b228ebc77f96faaba09cd9c63db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9f83e94a6ecae10b6bff851d76ffef24"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__zdma.html#ga9f83e94a6ecae10b6bff851d76ffef24">XZDma_SetChDataConfig</a> (<a class="el" href="struct_x_z_dma.html">XZDma</a> *InstancePtr, <a class="el" href="struct_x_z_dma___data_config.html">XZDma_DataConfig</a> *Configure)</td></tr>
<tr class="memdesc:ga9f83e94a6ecae10b6bff851d76ffef24"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets the data attributes and control configurations of a ZDMA core based on the inputs provided.  <a href="group__zdma.html#ga9f83e94a6ecae10b6bff851d76ffef24">More...</a><br/></td></tr>
<tr class="separator:ga9f83e94a6ecae10b6bff851d76ffef24"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacdca22a1e7cd74b3f2acbfec3f0509f4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__zdma.html#gacdca22a1e7cd74b3f2acbfec3f0509f4">XZDma_GetChDataConfig</a> (<a class="el" href="struct_x_z_dma.html">XZDma</a> *InstancePtr, <a class="el" href="struct_x_z_dma___data_config.html">XZDma_DataConfig</a> *Configure)</td></tr>
<tr class="memdesc:gacdca22a1e7cd74b3f2acbfec3f0509f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function gets the data attributes and control configurations of a ZDMA core.  <a href="group__zdma.html#gacdca22a1e7cd74b3f2acbfec3f0509f4">More...</a><br/></td></tr>
<tr class="separator:gacdca22a1e7cd74b3f2acbfec3f0509f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga860cde1482bc78429ea5c6f1d3da9014"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__zdma.html#ga860cde1482bc78429ea5c6f1d3da9014">XZDma_SetChDscrConfig</a> (<a class="el" href="struct_x_z_dma.html">XZDma</a> *InstancePtr, <a class="el" href="struct_x_z_dma___dscr_config.html">XZDma_DscrConfig</a> *Configure)</td></tr>
<tr class="memdesc:ga860cde1482bc78429ea5c6f1d3da9014"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets the descriptor attributes based on the inputs provided in the structure.  <a href="group__zdma.html#ga860cde1482bc78429ea5c6f1d3da9014">More...</a><br/></td></tr>
<tr class="separator:ga860cde1482bc78429ea5c6f1d3da9014"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga595ab84007b44249fe04571d18856158"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__zdma.html#ga595ab84007b44249fe04571d18856158">XZDma_GetChDscrConfig</a> (<a class="el" href="struct_x_z_dma.html">XZDma</a> *InstancePtr, <a class="el" href="struct_x_z_dma___dscr_config.html">XZDma_DscrConfig</a> *Configure)</td></tr>
<tr class="memdesc:ga595ab84007b44249fe04571d18856158"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function gets the descriptor attributes of the channel.  <a href="group__zdma.html#ga595ab84007b44249fe04571d18856158">More...</a><br/></td></tr>
<tr class="separator:ga595ab84007b44249fe04571d18856158"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga15a0124d42f8ff48e54f32c1b643fe7b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__zdma.html#ga15a0124d42f8ff48e54f32c1b643fe7b">XZDma_WOData</a> (<a class="el" href="struct_x_z_dma.html">XZDma</a> *InstancePtr, u32 *Buffer)</td></tr>
<tr class="memdesc:ga15a0124d42f8ff48e54f32c1b643fe7b"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function preloads the buffers which will be used in write only mode.  <a href="group__zdma.html#ga15a0124d42f8ff48e54f32c1b643fe7b">More...</a><br/></td></tr>
<tr class="separator:ga15a0124d42f8ff48e54f32c1b643fe7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7cb39835692353e5c34d95938b8ce8d0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__zdma.html#ga7cb39835692353e5c34d95938b8ce8d0">XZDma_Resume</a> (<a class="el" href="struct_x_z_dma.html">XZDma</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga7cb39835692353e5c34d95938b8ce8d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function resume the paused state of ZDMA core and starts the transfer from where it has paused.  <a href="group__zdma.html#ga7cb39835692353e5c34d95938b8ce8d0">More...</a><br/></td></tr>
<tr class="separator:ga7cb39835692353e5c34d95938b8ce8d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf236c2323636d87ab0888b2d6f55a313"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__zdma.html#gaf236c2323636d87ab0888b2d6f55a313">XZDma_Reset</a> (<a class="el" href="struct_x_z_dma.html">XZDma</a> *InstancePtr)</td></tr>
<tr class="memdesc:gaf236c2323636d87ab0888b2d6f55a313"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function resets the ZDMA core.  <a href="group__zdma.html#gaf236c2323636d87ab0888b2d6f55a313">More...</a><br/></td></tr>
<tr class="separator:gaf236c2323636d87ab0888b2d6f55a313"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabbb337d990f31dc8932356f5abeb78bf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="xzdma_8h.html#a19f8494063d56f2f39f9d40e6ded952a">XZDmaState</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__zdma.html#gabbb337d990f31dc8932356f5abeb78bf">XZDma_ChannelState</a> (<a class="el" href="struct_x_z_dma.html">XZDma</a> *InstancePtr)</td></tr>
<tr class="memdesc:gabbb337d990f31dc8932356f5abeb78bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns the state of ZDMA core.  <a href="group__zdma.html#gabbb337d990f31dc8932356f5abeb78bf">More...</a><br/></td></tr>
<tr class="separator:gabbb337d990f31dc8932356f5abeb78bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga70f7466e97aae2126181727774f6e6bb"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__zdma.html#ga70f7466e97aae2126181727774f6e6bb">XZDma_Start</a> (<a class="el" href="struct_x_z_dma.html">XZDma</a> *InstancePtr, <a class="el" href="struct_x_z_dma___transfer.html">XZDma_Transfer</a> *Data, u32 Num)</td></tr>
<tr class="memdesc:ga70f7466e97aae2126181727774f6e6bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets all the required fields for initiating data transfer.  <a href="group__zdma.html#ga70f7466e97aae2126181727774f6e6bb">More...</a><br/></td></tr>
<tr class="separator:ga70f7466e97aae2126181727774f6e6bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4e1c01839429d264c285bc7488b42fb8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__zdma.html#ga4e1c01839429d264c285bc7488b42fb8">XZDma_ScatterGather</a> (<a class="el" href="struct_x_z_dma.html">XZDma</a> *InstancePtr, <a class="el" href="struct_x_z_dma___transfer.html">XZDma_Transfer</a> *Data, u32 Num)</td></tr>
<tr class="memdesc:ga4e1c01839429d264c285bc7488b42fb8"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets all the required fields for initiating data transfer in scatter gather mode.  <a href="group__zdma.html#ga4e1c01839429d264c285bc7488b42fb8">More...</a><br/></td></tr>
<tr class="separator:ga4e1c01839429d264c285bc7488b42fb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga34c98a505b24c6e549ed7f746a82676e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__zdma.html#ga34c98a505b24c6e549ed7f746a82676e">XZDma_Enable</a> (<a class="el" href="struct_x_z_dma.html">XZDma</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga34c98a505b24c6e549ed7f746a82676e"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function enables all the interrupts which user intended to enable and enables the ZDMA channel for initiating data transfer.  <a href="group__zdma.html#ga34c98a505b24c6e549ed7f746a82676e">More...</a><br/></td></tr>
<tr class="separator:ga34c98a505b24c6e549ed7f746a82676e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
